/**
 * Copyright © MyCollab
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.mycollab.module.file.service

import com.mycollab.db.persistence.service.IService

import java.awt.image.BufferedImage

/**
 * User avatar service which is responsible of uploading and getting avatar
 *
 * @author MyCollab Ltd.
 * @since 1.0
 */
interface UserAvatarService : IService {
    /**
     * @param username
     * @return
     */
    fun uploadDefaultAvatar(username: String): String

    /**
     * Upload user avatar
     *
     * @param image    current user avatar
     * @param username username
     * @param avatarId avatar id which usually be generated by MyCollab as a random
     * stream to avoid overlap or caching old avatar of system.
     * @return
     */
    fun uploadAvatar(image: BufferedImage, username: String, avatarId: String?): String

    /**
     * @param avatarId
     */
    fun removeAvatar(avatarId: String?)
}
